home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / strsv.z / strsv
Encoding:
Text File  |  2002-10-03  |  18.7 KB  |  397 lines

  1.  
  2.  
  3.  
  4. SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSTTTTRRRRSSSSVVVV, DDDDTTTTRRRRSSSSVVVV, CCCCTTTTRRRRSSSSVVVV, ZZZZTTTTRRRRSSSSVVVV - Solves a real or complex triangular system
  10.      of equations
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision
  14.  
  15.           Fortran:
  16.                CCCCAAAALLLLLLLL SSSSTTTTRRRRSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  17.  
  18.           C/C++:
  19.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  20.                vvvvooooiiiidddd ssssttttrrrrssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, ffffllllooooaaaatttt
  21.                *_a,,,, iiiinnnntttt _l_d_a,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  22.  
  23.      Double precision
  24.  
  25.           Fortran:
  26.                CCCCAAAALLLLLLLL DDDDTTTTRRRRSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  27.  
  28.           C/C++:
  29.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  30.                vvvvooooiiiidddd ddddttttrrrrssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee
  31.                *_a,,,, iiiinnnntttt _l_d_a,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  32.  
  33.      Single precision complex
  34.  
  35.           Fortran:
  36.                CCCCAAAALLLLLLLL CCCCTTTTRRRRSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  37.  
  38.           C/C++:
  39.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  40.                vvvvooooiiiidddd ccccttttrrrrssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  41.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  42.  
  43.           C++ STL:
  44.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  45.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  46.                vvvvooooiiiidddd ccccttttrrrrssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  47.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  48.  
  49.      Double precision complex
  50.  
  51.           Fortran:
  52.                CCCCAAAALLLLLLLL ZZZZTTTTRRRRSSSSVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  53.  
  54.           C/C++:
  55.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  56.                vvvvooooiiiidddd zzzzttttrrrrssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  57.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.           C++ STL:
  75.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  76.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  77.                vvvvooooiiiidddd zzzzttttrrrrssssvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  78.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  79.  
  80. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  81.      These routines are part of the SCSL Scientific Library and can be loaded
  82.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  83.      directs the linker to use the multi-processor version of the library.
  84.  
  85.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  86.      4 bytes (32 bits). Another version of SCSL is available in which integers
  87.      are 8 bytes (64 bits).  This version allows the user access to larger
  88.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  89.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  90.      only one of the two versions; 4-byte integer and 8-byte integer library
  91.      calls cannot be mixed.
  92.  
  93.      The C and C++ prototypes shown above are appropriate for the 4-byte
  94.      integer version of SCSL. When using the 8-byte integer version, the
  95.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  96.      file should be included.
  97.  
  98. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  99.      SSSSTTTTRRRRSSSSVVVV and DDDDTTTTRRRRSSSSVVVV solve a real triangular system of equations.
  100.  
  101.      CCCCTTTTRRRRSSSSVVVV and ZZZZTTTTRRRRSSSSVVVV solve a complex triangular system of equations.
  102.  
  103.      These routines solve one of the following systems of equations, using the
  104.      operation associated with each:
  105.  
  106.           EEEEqqqquuuuaaaattttiiiioooonnnnssss      OOOOppppeeeerrrraaaattttiiiioooonnnn
  107.  
  108.           _A_x=_b           _x <- _A-_1_x
  109.  
  110.           _A_T_x=_b          _x <- _A-_T_x
  111.  
  112.           _A_H_x=_b          _x <- _A-_H_x (CCCCTTTTRRRRSSSSVVVV, ZZZZTTTTRRRRSSSSVVVV only)
  113.  
  114.      where
  115.  
  116.      *   _b and _x are _n-element vectors
  117.  
  118.      *   _A is either a unit or nonunit _n-by-_n upper or lower triangular matrix
  119.  
  120.      *   _A-_1 is the inverse of _A
  121.  
  122.      *   _A_T is the transpose of _A
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      *   _A-_T is the inverse of _A_T
  141.  
  142.      *   _A_H is the conjugate transpose of _A
  143.  
  144.      *   _A-_H is the inverse of _A_H
  145.  
  146.      On input, the right-hand side vector _b is stored in array argument _x.  On
  147.      output, the solution vector _x overwrites _b in the same array argument _x.
  148.  
  149.      See the NOTES section of this man page for information about the
  150.      interpretation of the data types described in the following arguments.
  151.  
  152.      These routines have the following arguments:
  153.  
  154.      _u_p_l_o      Character.  (input)
  155.                Specifies whether the matrix is an upper or lower triangular
  156.                matrix, as follows:
  157.  
  158.                _u_p_l_o = 'U' or 'u':  _A is an upper triangular matrix.
  159.                _u_p_l_o = 'L' or 'l':  _A is a lower triangular matrix.
  160.  
  161.                For C/C++, a pointer to this character is passed.
  162.  
  163.      _t_r_a_n_s     Character.  (input)
  164.                Specifies the operation to be performed, as follows:
  165.  
  166.                _t_r_a_n_s = 'N' or 'n':  _x <- _A-_1_x
  167.  
  168.                _t_r_a_n_s = 'T' or 't':  _x <- _A-_T_x
  169.  
  170.                _t_r_a_n_s = 'C' or 'c':  _x <- _A-_T_x (SSSSTTTTRRRRSSSSVVVV, DDDDTTTTRRRRSSSSVVVV), or _x <- _A-_H_x
  171.                (CCCCTTTTRRRRSSSSVVVV, ZZZZTTTTRRRRSSSSVVVV)
  172.  
  173.                For C/C++, a pointer to this character is passed.
  174.  
  175.      _d_i_a_g      Character.  (input)
  176.                Specifies whether _A is unit triangular, as follows:
  177.  
  178.                _d_i_a_g = 'U' or 'u': _A is assumed to be unit triangular.
  179.                _d_i_a_g = 'N' or 'n': _A is not assumed to be unit triangular.
  180.  
  181.                For C/C++, a pointer to this character is passed.
  182.  
  183.      _n         Integer.  (input)
  184.                Specifies the order of matrix _A.  _n >= 0.
  185.  
  186.      _a         Array of dimension (_l_d_a,_n).  (input)
  187.                SSSSTTTTRRRRSSSSVVVV: Single preicsion array.
  188.                DDDDTTTTRRRRSSSSVVVV: Double precision array.
  189.                CCCCTTTTRRRRSSSSVVVV: Single precision complex array.
  190.                ZZZZTTTTRRRRSSSSVVVV: Double precision complex array.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))
  203.  
  204.  
  205.  
  206.                Before entry with _u_p_l_o = 'U' or 'u', the leading _n-by-_n upper
  207.                triangular part of array _a must contain the upper triangular
  208.                matrix.  The strictly lower triangular part of _a is not
  209.                referenced.
  210.  
  211.                Before entry with _u_p_l_o = 'L' or 'l', the leading _n-by-_n lower
  212.                triangular part of array _a must contain the lower triangular
  213.                matrix.  The strictly upper triangular part of _a is not
  214.                referenced.
  215.  
  216.                When _d_i_a_g = 'U' or 'u', these routines assume that all elements
  217.                of array _a that represent diagonal elements of matrix _A are 1.
  218.                In this case, neither of these routines will reference any of
  219.                the diagonal elements.
  220.  
  221.      _l_d_a       Integer.  (input)
  222.                Specifies the first dimension of _a as declared in the calling
  223.                program.  _l_d_a >= MMMMAAAAXXXX(1,_n).
  224.  
  225.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input and output)
  226.                SSSSTTTTRRRRSSSSVVVV: Single precision array.
  227.                DDDDTTTTRRRRSSSSVVVV: Double precision array.
  228.                CCCCTTTTRRRRSSSSVVVV: Single precision complex array.
  229.                ZZZZTTTTRRRRSSSSVVVV: Double precision complex array.
  230.  
  231.                On input, _x contains the right-hand side vector _b.  On output,
  232.                _x is overwritten with the solution vector _x.
  233.  
  234.      _i_n_c_x      Integer.  (input)
  235.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  236.                be 0.
  237.  
  238. NNNNOOOOTTTTEEEESSSS
  239.      Tests for singularity or near-singularity are not included in these
  240.      routines.  You must perform such tests before calling either routine.
  241.  
  242.      These routines are Level 2 Basic Linear Algebra Subprograms (Level 2
  243.      BLAS).
  244.  
  245.      When working backward (_i_n_c_x < 0), each routine starts at the end of the
  246.      vector and moves backward, as follows:
  247.  
  248.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)
  249.  
  250.  
  251.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  252.      The following data types are described in this documentation:
  253.  
  254.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))
  269.  
  270.  
  271.  
  272.      Fortran:
  273.  
  274.           Array dimensioned _n           xxxx((((nnnn))))
  275.  
  276.           Array of dimensions (_m,_n)     xxxx((((mmmm,,,,nnnn))))
  277.  
  278.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  279.  
  280.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  281.  
  282.           Single precision              RRRREEEEAAAALLLL
  283.  
  284.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  285.  
  286.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  287.  
  288.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  289.  
  290.      C/C++:
  291.  
  292.           Array dimensioned _n           xxxx[[[[_n]]]]
  293.  
  294.           Array of dimensions (_m,_n)     xxxx[[[[mmmm****nnnn]]]]
  295.  
  296.           Character                     cccchhhhaaaarrrr
  297.  
  298.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  299.  
  300.           Single precision              ffffllllooooaaaatttt
  301.  
  302.           Double precision              ddddoooouuuubbbblllleeee
  303.  
  304.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  305.  
  306.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  307.  
  308.      C++ STL:
  309.  
  310.           Array dimensioned _n           xxxx[[[[_n]]]]
  311.  
  312.           Array of dimensions (_m,_n)     xxxx[[[[mmmm****nnnn]]]]
  313.  
  314.           Character                     cccchhhhaaaarrrr
  315.  
  316.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  317.  
  318.           Single precision              ffffllllooooaaaatttt
  319.  
  320.           Double precision              ddddoooouuuubbbblllleeee
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRSSSSVVVV((((3333SSSS))))
  335.  
  336.  
  337.  
  338.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  339.  
  340.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  341.  
  342.      Note that you can explicitly declare multidimensional C/C++ arrays
  343.      provided that the array dimensions are swapped with respect to the
  344.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  345.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  346.      message in C), however, the array should be cast to a pointer of the
  347.      appropriate type when passed as an argument to a SCSL routine.
  348.  
  349. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  350.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S)
  351.  
  352.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  353.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  354.      Linear Algebra Subprograms Technical Forum.
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.                                                                         PPPPaaaaggggeeee 6666
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.